<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Sets phar archive meta-data</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="phar.setdefaultstub.html">Phar::setDefaultStub</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="phar.setsignaturealgorithm.html">Phar::setSignatureAlgorithm</a></div>
 <div class="up"><a href="class.phar.html">Phar</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.setmetadata" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Phar::setMetadata</h1>
  <p class="verinfo">(PHP &gt;= 5.3.0, PECL phar &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::setMetadata</span> &mdash; <span class="dc-title">Sets phar archive meta-data</span></p>

 </div>
 
 
 <div class="refsect1 description" id="refsect1-phar.setmetadata-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><a href="phardata.setmetadata.html" class="methodname">Phar::setMetadata</a></span>
    ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$metadata</code></span>
   )</div>

 <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">此方法需要
将 <var class="filename">php.ini</var> 中的 <em>phar.readonly</em> 设为
<em>0</em> 以适合 <a href="class.phar.html" class="classname">Phar</a>
对象.  否则, 将抛出<a href="class.pharexception.html" class="classname">PharException</a>.</p></p></blockquote>

  <p class="para">
   <span class="function"><a href="phardata.setmetadata.html" class="function">Phar::setMetadata()</a></span> should be used to store customized data
   that describes something about the phar archive as a complete entity.
   <span class="function"><a href="pharfileinfo.setmetadata.html" class="function">PharFileInfo::setMetadata()</a></span> should be used for file-specific meta-data.
   Meta-data can slow down the performance of loading a phar archive if the data is large. 
  </p>
  <p class="para">
   Some possible uses for meta-data include specifying which file within the archive
   should be used to bootstrap the archive, or the location of a file manifest
   like <a href="http://pear.php.net/" class="link external">&raquo;&nbsp;PEAR</a>&#039;s package.xml file.
   However, any useful data that describes the phar archive may be stored.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-phar.setmetadata-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<em><code class="parameter">metadata</code></em></dt>

     <dd>

      <p class="para">
       Any PHP variable containing information to store that describes the phar archive
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-phar.setmetadata-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   没有返回值。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-phar.setmetadata-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-672">
    <p><strong>Example #1 A <span class="function"><a href="phardata.setmetadata.html" class="function">Phar::setMetadata()</a></span> example</strong></p>
    <div class="example-contents"><p>
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//&nbsp;make&nbsp;sure&nbsp;it&nbsp;doesn't&nbsp;exist<br /></span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />try&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$p&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">'/brandnewphar.phar'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.php'</span><span style="color: #007700">]&nbsp;=&nbsp;</span><span style="color: #DD0000">'&lt;?php&nbsp;echo&nbsp;"hello"'</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$p</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'bootstrap'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'file.php'</span><span style="color: #007700">));<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMetadata</span><span style="color: #007700">());<br />}&nbsp;catch&nbsp;(</span><span style="color: #0000BB">Exception&nbsp;$e</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">'Could&nbsp;not&nbsp;create&nbsp;and/or&nbsp;modify&nbsp;phar:'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents"><p>以上例程会输出：</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
array(1) {
  [&quot;bootstrap&quot;]=&gt;
  string(8) &quot;file.php&quot;
}
</pre></div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-phar.setmetadata-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="phar.getmetadata.html" class="function" rel="rdfs-seeAlso">Phar::getMetadata()</a> - Returns phar archive meta-data</span></li>
    <li class="member"><span class="function"><a href="phar.delmetadata.html" class="function" rel="rdfs-seeAlso">Phar::delMetadata()</a> - Deletes the global metadata of the phar</span></li>
    <li class="member"><span class="function"><a href="phar.hasmetadata.html" class="function" rel="rdfs-seeAlso">Phar::hasMetadata()</a> - Returns whether phar has global meta-data</span></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="phar.setdefaultstub.html">Phar::setDefaultStub</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="phar.setsignaturealgorithm.html">Phar::setSignatureAlgorithm</a></div>
 <div class="up"><a href="class.phar.html">Phar</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
